/*
 * ------------------------------------------------------------------------
 *
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * History
 *   May 24, 2014 (wiswedel): created
 */
package org.knime.core.node.workflow;

import java.io.File;

import org.knime.core.internal.ReferencedFile;

/**
 * Helper object to specify options when workflow gets saved.
 * @author Bernd Wiswedel, KNIME AG, Zurich, Switzerland
 * @since 2.10
 */
public final class WorkflowSaveHelper {

    private boolean m_saveData;
    private boolean m_isAutoSave;
    private boolean m_isSaveWizardController;

    /**
     * @param saveData ...
     * @param isAutoSave ...
     */
    public WorkflowSaveHelper(final boolean saveData, final boolean isAutoSave) {
        m_saveData = saveData;
        m_isAutoSave = isAutoSave;
        m_isSaveWizardController = false;
    }

    /** @return the saveData */
    public boolean isSaveData() {
        return m_saveData;
    }
    /** @param saveData the saveData to set
     * @return this (for method chaining). */
    public WorkflowSaveHelper setSaveData(final boolean saveData) {
        m_saveData = saveData;
        return this;
    }
    /** @return the isAutoSave */
    public boolean isAutoSave() {
        return m_isAutoSave;
    }
    /** @param isAutoSave the isAutoSave to set
     * @return this (for method chaining). */
    public WorkflowSaveHelper setAutoSave(final boolean isAutoSave) {
        m_isAutoSave = isAutoSave;
        return this;
    }
    /** @return the isSaveWizardController
     * @since 2.11 */
    public boolean isSaveWizardController() {
        return m_isSaveWizardController;
    }
    /** @param value the isSaveWizardController to set
     * @return this (for method chaining).
     * @since 2.11 */
    public WorkflowSaveHelper setSaveWizardController(final boolean value) {
        m_isSaveWizardController = value;
        return this;
    }

    public static File getAutoSaveDirectory(final ReferencedFile workflowDir) {
        File f = workflowDir.getFile();
        return new File(f.getParentFile(), "." + f.getName() + ".autoSave");
    }

}
